docs: libxc migration stream specification
authorDavid Vrabel <david.vrabel@citrix.com>
Tue, 3 Jun 2014 13:48:12 +0000 (14:48 +0100)
committerAndrew Cooper <andrew.cooper3@citrix.com>
Tue, 5 May 2015 13:30:47 +0000 (14:30 +0100)
commitedfb555d86f5f91f5501fd1c2181a6c6c1c809ae
treec1aff229917d7b651207cc8ed878457f0adc640e
parent93c2ff78adcadbe0f8bda57eeb30b1414c966324
docs: libxc migration stream specification

Add the specification for a new migration stream format.  The document
includes all the details but to summarize:

The existing (legacy) format is dependant on the word size of the
toolstack.  This prevents domains from migrating from hosts running
32-bit toolstacks to hosts running 64-bit toolstacks (and vice-versa).

The legacy format lacks any version information making it difficult to
extend in compatible way.

The new format has a header (the image header) with version information,
a domain header with basic information of the domain and a stream of
records for the image data.

The format will be used for future domain types (such as on ARM).

The specification is pandoc format (an extended markdown format) and the
documentation build system is extended to support pandoc format documents.

Signed-off-by: David Vrabel <david.vrabel@citrix.com>
Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
Acked-by: Ian Campbell <Ian.Campbell@citrix.com>
docs/specs/libxc-migration-stream.pandoc [new file with mode: 0644]